home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 034a / shuffl20.zip / SHUFFLE.DOC < prev    next >
Text File  |  1992-02-20  |  17KB  |  378 lines

  1.  
  2.                               WORD SHUFFLE
  3.  
  4.                                   v2.0
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.       
  14.                               
  15.                                 OVERVIEW
  16.                                 ________
  17.  
  18.  
  19.    Word Shuffle is a word game whereby the computer has scrambled the 
  20.    letters of a word and you must unscramble it to make points. The
  21.    game is pretty straight forward and the package also contains a 
  22.    program which add new puzzles to the database and as an event, will 
  23.    create new puzzles and start a new game, as soon as a pre-determined
  24.    number of players have solved all the puzzles. This is done 
  25.    automatically, all you must do is ensure that there are an adequate 
  26.    suppply of puzzles in the database. The same program used in the event
  27.    process is the same one you will use to add words to the database.
  28.  
  29.  
  30.  
  31.  
  32.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  33.          created in the directory you run the door from.
  34.  
  35.  
  36.                               INSTALLATION
  37.                               ____________
  38.  
  39.  
  40.    Installation is fairly easy and straight-forward. The following steps and
  41.    examples should have you up and running in a very short period of time.
  42.    It is assumed that you are familiar with setting up DOORS on your system.
  43.    To this end, only examples of the configuration file and Door batch file
  44.    are described.
  45.  
  46.       1) Create a directory to hold all WORD SHUFFLE files.
  47.  
  48.       2) Unzip SHUFFLxx.ZIP into the the above directory.
  49.  
  50.          NOTE: BRUN45.EXE is not included but is required !!!
  51.  
  52.       3) Create a configuration file, with a name of your choice, or
  53.          modify the supplied SHUFFLE.CFG file. A description follows:
  54.  
  55.             **                       Location of System File (See Below)
  56.             SUNRISE-80 BBS           Your BBS Name
  57.             Al                       Sysop's First Name
  58.             Lawrence                 Sysop's Last name
  59.             00000000                 Registration Number
  60.  
  61.     1   #   1                        Number of plays per day/caller (1-3)
  62.                                      (Sysop gets 99 in registerd version ONLY!)
  63.  
  64.         #   2                        Keyboard Timeout Value in Minutes.
  65.  
  66.             50                       Number of entries in the Top Score file
  67.  
  68.         #   NONE                     Full drive:\path\filename for Top Score
  69.                                      Bulletin, or NONE
  70.  
  71.         #   NONE                     Full drive:\path\filename for Top Score
  72.                                      Bulletin (Color), or NONE
  73.  
  74.         #   20                       Number of puzzles comprising the game(QUE)
  75.  
  76.             2                        1 = Do Not Display ADOPT-A-DOOR Message
  77.                                      2 = Display ADOPT-A-DOOR Message
  78.  
  79.             3                        The number of players that must complete
  80.                                      all puzzles, before the puzzles are 
  81.                                      changed automatically by SHUFWORD, in 
  82.                                      your nightly event processing.
  83.  
  84.     !   #   0                        Time Remaining in Door
  85.                                      (Sysop = Time Remaining - REG. VERSION)
  86.  
  87.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  88.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  89.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  90.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  91.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  92.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  93.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  94.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  95.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  96.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  97.  
  98.     @   #   XXXX/YYYY                 Blackout Range  From/To
  99.     @   #   XXXX/YYYY                 Blackout Range  From/To
  100.     @   #   XXXX/YYYY                 Blackout Range  From/To
  101.     @   #   XXXX/YYYY                 Blackout Range  From/To
  102.     @   #   XXXX/YYYY                 Blackout Range  From/To
  103.  
  104.          ** = Replace with ONE of the following:
  105.  
  106. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  107. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  108. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  109.                                    (Note:DOOR.SYS must be in SAME directory)
  110. C:\BBS\DOOR.SYS                 <- For systems that support DOOR.SYS
  111. C:\BBS\DORINFOx.DEF             <- For QBBS/RBBS/RA. Replace x with Node #.
  112. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  113. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  114.  
  115.  
  116.          # =  Requires registration to change to a different value
  117.          ! = See "Plays Per DAY/DOOR Time" Below
  118.          @ = See "Blackout Periods" Below
  119.  
  120.  
  121.               NOTE:THERE ARE TO BE NO BLANK LINES IN THIS FILE !
  122.  
  123.       4) When running more than one node, be sure to supply a different 
  124.          configuration name for each node (your choice of name) and 
  125.          change the first entry in the .CFG (if necessary).
  126.  
  127.  
  128.  
  129.                           BLACKOUT PERIODS
  130.                           ________________
  131.  
  132.       Use the Blackout ranges option to define up to 5 time periods during
  133.       which you DO NOT want the Door to be played. If a caller tries to access 
  134.       the Door during the Blackout period, they will be shown a message that
  135.       contains ALL the Blackout periods you have defined, and to try the Door
  136.       at a later time.
  137.  
  138.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  139.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  140.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  141.  
  142.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  143.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  144.                    a Blackout range.
  145.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  146.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  147.  
  148.  
  149.                           PLAYS Per DAY/DOOR Time
  150.                           _______________________
  151.  
  152.       Plays Per Day and Door Time can be controlled several ways:
  153.  
  154.       (1) You can use the Games Per Day, singular option, in the config
  155.           file above. This option, will affect ALL callers whose Security
  156.           Level is NOT defined in any of the 10 optional Security Level/
  157.           Plays Per Day entries in the config file.
  158.  
  159.       (2) You can use the Door Time, singular option, in the config file
  160.           above. This option, will affect ALL callers whose Security
  161.           Level is NOT defined in any of the 10 optional Security Level/
  162.           Plays Per Day/Door Time entries in the config file.
  163.  
  164.       (3) You can restrict the number of games a specific Security Level
  165.           will be allowed to play per day or REWARD specific Levels with 
  166.           more Plays Per Day. 
  167.  
  168.           Likewise, you can restrict the Play time for a specific Security
  169.           Level or REWARD specific Levels with more Door Time.
  170.  
  171.           These options are handled by the use of the 10 config 
  172.           entries (000=00/00). 
  173.           
  174.           The format of each entry is as follows:
  175.  
  176.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  177.                      where =  is a constant and MUST be included
  178.                      where YY is the # of games per day (must be 2 digits)
  179.                      where / is a constant and MUST be included
  180.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  181.           
  182.           If the callers Security Level is NOT defined, his/her Plays Per
  183.           Day and Door Time will be controlled by the values in items
  184.           (1) and (2), above, respectively..
  185.  
  186.           You may define up to 10 Security Levels. All unused entries must
  187.           be defined as   000=00/00
  188.         --------------------------------------------------------------------
  189.           Example: Suppose you had 3 Security Levels defined on your BBS as
  190.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  191.           wanted to set Plays Per Day as :     Subscriber=5
  192.                                            Visiting Sysop=2
  193.                                                   CoSysop=3
  194.                                                    Friend=10 
  195.           
  196.           and Door Time as follows:     Subscriber=30 minutes
  197.                                     Visiting Sysop=20 minutes
  198.                                            CoSysop=10 minutes 
  199.                                             Friend=remaining call time
  200.                                
  201.  
  202.           You would set the Individual "Games per Day" config entry to 1 and 
  203.           the individual "Door Time" to 5 minutes (these would be the 
  204.           default number of games and default Time for all Security Levels
  205.           other than 20,30 or 40... make them any number you want). Next you
  206.           would replace 4 of the Security Level entries as :  020=05/30                                               
  207.                                                               030=02/20
  208.                                                               040=03/10
  209.                                                               090=10/0
  210.  
  211.  
  212.  
  213.  
  214.                                COM Support
  215.                                ___________
  216.  
  217.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  218.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  219.       number after the configuration filename. Let's assume your Door is
  220.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  221.       passed to your Door would be:
  222.                                    FOOBAR FOOBAR.CFG /5
  223.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  224.       normally used with COM1. No /x parameter is needed for the standard
  225.       IRQ's.
  226.  
  227.  
  228.  
  229.                                 SHUFWORD
  230.                                 ---------
  231.  
  232.     This is the Word Shuffle utility maintenance progam. This program is
  233.     used to add words to the Shuffle database and to perform the nightly 
  234.     maintenance.
  235.  
  236.     Note: If running an unregistered copy you will be restricted to 60
  237.           words in the Shuffle database vs 1000 words in the registered
  238.           copy and you will not be able to run as a nightly event.
  239.  
  240.      ********************************************************************
  241.      *                                                                  *
  242.      *   Assuming that your config file is named SHUFFLE.CFG, use the   *
  243.      *   following EXAMPLE to run SHUFWORD to add words to the         *
  244.      *   SHUFFLE database.                     ^^^^^^^^^                *
  245.      *                                                                  *
  246.      *                  cd\pcb\doors\shuffle                            *           
  247.      *                  SHUFWORD SHUFFLE.CFG                           *
  248.      *                                                                  *
  249.      ********************************************************************                                                                
  250.  
  251.  
  252.                              EVENT PROCESSING
  253.                              ________________
  254.  
  255.     After your callers complete all the words you have defined, it becomes
  256.     necessary to change them and start a new game. This task can be done 
  257.     manually, using SHUFWORD or automatically, as part of your nightly 
  258.     EVENT process.
  259.  
  260.     As a nightly EVENT, SHUFWORD checks to see if the number of players, 
  261.     as defined in the configuration file, have completed all words, in which
  262.     case it will automatically supply a new set of words and reset/update 
  263.     the appropriate files. The following is an EXAMPLE of what needs to be 
  264.     placed in your EVENT.SYS file (PcBoard):
  265.  
  266.  
  267.            CD\PCB\DOORS\SHUFFLE        Location of SHUFFLE files
  268.            SHUFWORD SHUFFLE.CFG /E     EXE filename and config filename
  269.            CD\PCB
  270.            BOARD
  271.  
  272.  
  273.  
  274.              
  275.  
  276.  
  277.  
  278.  
  279.                                ADOPT-A-DOOR
  280.                                ____________
  281.  
  282.  
  283.     Having been a Sysop for a number of years, I have had my share of problems
  284.     and frustrations getting financial support for my board's upkeep. A fellow
  285.     Sysop left a message on my board, not long ago, about a concept that was
  286.     being used by several boards around the country.
  287.  
  288.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  289.     would be the same as sending in a donation, only this way it is earmarked
  290.     for registering a particular door. In a way, the user feels he/she is
  291.     "getting something in return". As a Door author I have decided to build
  292.     this concept into each of my Door programs. The concept replaces the
  293.     usual message "tell the Sysop to register this Door" we find in most
  294.     doors.
  295.  
  296.     If the Door is unregisterd then a message appears on the opening screen
  297.     to that effect. After finishing or suspending a game, a message screen
  298.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  299.     caller to contact the Sysop to find out if there is any further details
  300.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  301.     time, etc to callers that ADOPT-A-DOOR.
  302.  
  303.     If the Door has been registered, either by the Sysop or other callers,
  304.     the names of those contributors will be displayed in the closing screen.
  305.  
  306.     NOTE: If you want to display the names of the callers that contributed
  307.           to registering the Door, you must create an ASCII file called
  308.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  309.           the name(s) of the contributors (one on each line, maximum of 5
  310.           entries, each a maximum of 30 characters long). This file must be
  311.           saved, in ASCII format, and placed in the Door directory.
  312.  
  313.  
  314.  
  315.                               LEGALITIES
  316.                               __________
  317.  
  318.  
  319.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  320.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  321.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  322.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  323.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  324.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  325.       OR BREACH OF ANY WARRANTY.
  326.  
  327.  
  328.  
  329.  
  330.  
  331.                              DISTRIBUTION
  332.                              ____________
  333.  
  334.    You may make this file available for downloading from your BBS or you may
  335.    upload it to any BBS of your choice, provided that you do not make any
  336.    changes to the contents of the archive (ZIP file). The archive and its
  337.    individual contents may not be used by any service that charges any money
  338.    whatsoever, without the written permission of the author.
  339.  
  340.  
  341.  
  342.  
  343.  
  344.                              REGISTRATION
  345.                              ____________
  346.  
  347.    Registration and the subsequent insertion of the registration number into
  348.    your configuation file, allows for the display of your BBS name on the
  349.    opening and closing screen as well as the reduction of a delay built into
  350.    the opening screen display along with the ability to change certain values
  351.    in the configuration file.
  352.  
  353.    To register your copy of WORD SHUFFLE, please fill out the registration
  354.    form (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  355.    the name and address on the form or supply a self-addressed stamped 
  356.    envelope for registration number by return mail.t
  357.  
  358.    Be sure to use the proper upper/lower case when filling in your name and
  359.    BBS name, as they MUST match the way you entered them in the configuration
  360.    file.             ^^^^
  361.  
  362.    Based upon information supplied on the registration form, I will pre-
  363.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  364.    up your registration number.
  365.  
  366.  
  367.  
  368.                                  MISC
  369.                                  ____
  370.  
  371.    The latest version of WORD SHUFFLLE and other fine SUNRISE DOOR programs
  372.    are always available for download from SUNRISE-80 BBS.
  373.  
  374.    Remember, should you have any problems, questions or suggestions, be sure
  375.    to drop me a message on either of the aforementioned BBS'.  I am now a 
  376.    PCRelay node (SUNRISE) and can be reached thru the SYSOP, BBSDOORS, 
  377.    PCBhints RIME conferences.
  378.